home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / pcb / ip152.zip / IP.DOC < prev    next >
Text File  |  1993-01-17  |  19KB  |  429 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                InterPCB 1.52
  7.                            Revised Jan 17, 1993
  8.  
  9.  
  10.  
  11.  
  12.  
  13.                 Copyright 1990-1993 InterZone Software, Inc.
  14.                             All Rights Reserved
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                 Written by
  22.                     Peter Stewart and Michele Hamilton
  23.  
  24.  
  25.  
  26.  
  27.                                 FILES LIST
  28.                                 ==========
  29.  
  30.           IP.EXE         Program
  31.           IP.BAT         Sample batch file
  32.           IP.DOC         This documentation
  33.           WIPE.EXE       Utility to delete all files with the same extension.
  34.           INTERZ.REG     Registration Form
  35.           IP.NEW         History of new options and fixes
  36.  
  37.  
  38.                               INTRODUCTION
  39.                               ============
  40.  
  41.     This program was born out of frustration with the existing programs
  42.     to import Fido-style messages into a PCBoard  message base and
  43.     and vice versa. The programs that were out there when we started
  44.     work on it were too big, too slow and/or too unreliable.
  45.  
  46.     So we wrote InterPCB. It is a fast, simple, easy to use commandline
  47.     program that will take each fido *.msg and import it into a PCBoard
  48.     message base, updating the index and even reformatting. It ain't
  49.     pretty, but it does what it's supposed to do time after time
  50.     after time. Which is, after all, what a program should always be.
  51.  
  52.  
  53.                     NOTICES, WARRANTIES AND GUARANTEE
  54.                     =================================
  55.  
  56.     This program has no warranty or guarantee other than to take up
  57.     space on your hard drive. This program is Shareware and should be
  58.     considered user supported software.
  59.  
  60.     This program MAY NOT be commercially reproduced or sold by anyone.
  61.     This includes as part of a software library in which the user pays
  62.     for the cost of the disk. The author reserves all rights to this
  63.     program.
  64.  
  65.     This program is distributed as SHAREWARE. This means that, if you like
  66.     the program and continue to use it for more than 2 weeks, you must
  67.     register it. Registration will entitle you to full support through
  68.     FidoNet or BBSNet Netmail or the Support boards listed below.
  69.  
  70.     Additionally, you will be allowed to download future beta versions
  71.     of InterPCB. To be listed as a future beta tester, call SunShine
  72.     PCBoard and fill out Questionnaire #3. Many exciting new features
  73.     will go into beta testing immediately following this release!
  74.  
  75.     To register this program, mail your check or money order for $20.00,
  76.     together with the registration form, to:
  77.  
  78.                     InterZone Software, Inc.
  79.                     9050 Pines Blvd., Suite 430
  80.                     Pembroke Pines, FL 33024
  81.  
  82.                               ABOUT INTERPCB
  83.                               ==============
  84.  
  85.     InterPCB exports messages from the PCBoard message bases to the *.msg
  86.     format that is standard in Fidonet. It will also import incoming
  87.     messages in *.msg format to the PCBoard message bases. To be able to
  88.     participate in echomail conferences, you must also use an echomail
  89.     processor, like ConfMail or TosScan.
  90.  
  91.     Using InterPCB is fairly straight forward. To get a list of options or
  92.     help, simply type "IP" with no arguments. InterPCB does not require a
  93.     configuration file and is most easily run as an event through a batch
  94.     file.
  95.  
  96.     After the import/export stage is finished, it is not necessary to pack
  97.     the message bases.
  98.  
  99.     The order in which the directory, pathname and other parameters are
  100.     listed is optional.
  101.  
  102.     Should a *.msg that has been exported from your message base not have
  103.     been deleted from the directory after being processed by your echomail
  104.     handler or your batch file, InterPCB will NOT re-import that message
  105.     when next it scans that directory for import.
  106.  
  107.     CAUTION:
  108.     If you are running ConfMail or an echomail processor other than TosScan,
  109.     InterPCB will have no way of knowing whether or not the message has
  110.     been sent since, as far as we know, TosScan is the only program which
  111.     toggles a 'sent' bit. Make sure that you either do NOT use an external
  112.     message editor or that you process your export of mail BEFORE attempt-
  113.     ing to use InterPCB to import messages. If you don't take these pre-
  114.     cautions this could cause the messages to be imported into PCBoard and
  115.     deleted from the Fido directory without being sent. (However, see the
  116.     /l (leave) option below.)
  117.  
  118.     InterPCB kills all *.msg files after they have been imported to a
  119.     message base - unless you use the /l (leave) option. However, it also
  120.     reads and/or toggles the following bits in any *.msg file to be imported
  121.     or exported from a PCBoard message base in order to determine if the
  122.     message should be deleted or not. You obviously don't want a message
  123.     deleted if it has not been processed for echomail handling yet.
  124.  
  125.  
  126.     -local         IP will set the local  bit "on" automatically for all
  127.                     messages  exported from  a PCBoard message base. This
  128.                     will allow TosScan to know that this message is local
  129.                     to the system and needs to be exported for mailing.
  130.  
  131.     -transit       IP will toggle the transit status automatically
  132.                     for all messages exported from or to a PCBoard message
  133.                     base. This allows IP to recognize that it has already
  134.                     imported/exported this message and to ignore it if it
  135.                     sees it again. If a message was written by an external
  136.                     editing program such as InterMail's or FrontDoor's
  137.                     editor or Xpress, but not yet sent out, after importing
  138.                     it to PCBoard IP will set the 'transit' bit on, so it
  139.                     knows that it shouldn't re-import the message. DO NOT
  140.                     use an external editor if you are using an echomail
  141.                     processor that doesn't use the 'Sent' bit!
  142.  
  143.     -sent          IP looks for the 'sent' bit and if not found, will import
  144.                     a locally entered message to your message base but will
  145.                     leave it in your directory for echomail handling.
  146.  
  147.  
  148.                             HOW TO USE InterPCB
  149.                             ===================
  150.  
  151.     The command syntax for InterPCB is as follows:
  152.  
  153.  
  154.     IP [options] /F:directory /P:pathname [options]
  155.  
  156.  
  157.      /inst          INSTALL. Use to install the sysop's name, a pathname for
  158.                     the log file, and an export areas file.
  159.  
  160.                     IP will automatically insert the sysop's name to replace
  161.                     SYSOP as originator/recipient of a local message.
  162.  
  163.                     If no log file name is installed, no statistics or error
  164.                     messages will be logged.
  165.  
  166.                     The export areas file is described below under the
  167.                     /n:name parameter.
  168.  
  169.                     NOTE: The installation is saved to the program file
  170.                     itself (IP.EXE), so the program has to be reinstalled
  171.                     every time you install a new version on your system.
  172.                     To see the current installation, you can just type IP
  173.                     without any parameters.
  174.  
  175.      /i             IMPORT. Tells InterPCB to import *.msg files to a PCBoard
  176.                     message base. Can be used together with the /e (export)
  177.                     option below, so that messages are both imported and
  178.                     exported in the same run.
  179.  
  180.      /e             EXPORT. Tells InterPCB to export mail from a PCBoard
  181.                     message base to *.msg files. Can be used together with
  182.                     the /i (import) option above.
  183.  
  184.      /f:directory   FIDO directory. Where the *.msg files can be found.
  185.  
  186.      /p:pathname    PCBOARD message base. Path and file name of the PCBoard
  187.                     message base.
  188.  
  189.      /n:name        Optional AREA NAME, to be used together with an installed
  190.                     export areas file. The area name specified with this
  191.                     parameter gets written to the export areas file if any
  192.                     messages have been exported. The export file can then
  193.                     be used to tell your echomail processor which areas to
  194.                     process.
  195.  
  196.                     NOTE: It is important that the export areas file is
  197.                     removed after processing in your batch file, since IP
  198.                     can't tell when it should be deleted. IP has no code
  199.                     to check if an area already has been added to the export
  200.                     file, so duplicate entries are possible if the file
  201.                     isn't removed properly. And finally: do NOT confuse this
  202.                     "disposable" file with your AREAS.BBS file!
  203.  
  204.      /max:nnn       MAX lines, optional. Where 'nnn' is the maximum number
  205.                     of lines InterPCB should process on importing a message
  206.                     to a PCB message base. Default is 99 lines as currently
  207.                     supported by PCB 14.2 and below. However, in the new
  208.                     PCBoard 14.5, you will have an option to increase your
  209.                     message base lines to 200. This option allows you to
  210.                     reset InterPCB's maximum number of lines to import.
  211.  
  212.      /s             SPLIT, optional. By default, InterPCB will truncate all
  213.                     messages over the 99 lines or the maximum number of lines
  214.                     as set by the /MAX:nnn parameter. Using the /s parameter
  215.                     will tell InterPCB to split a long fido message, that
  216.                     would otherwise be truncated, into two or more messages
  217.                     in the PCBoard message base.
  218.  
  219.      /a             ALL, optional. To avoid having to scan all messages each
  220.                     time InterPCB processes an export it will, by default,
  221.                     make and use a zero byte file that serves to tell it the
  222.                     last message number. Use the /A parameter to ignore this
  223.                     and process ALL messages in a base.
  224.  
  225.                     WARNING: Never use /a together with the /o option - it
  226.                     could cause a bunch of dupes to be scanned out!
  227.  
  228.      /k             KEEP seen-by lines, optional. Use if you wish to keep
  229.                     seen-by lines. The default is that all seen-by lines are
  230.                     stripped from the messages. (Seen-by lines are inserted
  231.                     by echomail processors and used in detecting/tracking down
  232.                     duplicate messages.)
  233.  
  234.      /h             HIGH-END ASCII, optional. IP will now strip high-end ASCII
  235.                     characters on export from PCB. This option will allow you
  236.                     to retain the characters in the range 128-254, if desired.
  237.                     (High-end ASCII characters are generally not allowed in
  238.                     Fidonet conferences, since they may cause problems for
  239.                     people running non-PC compatible machines. You should
  240.                     never allow high-end ASCII in general Fidonet echomail
  241.                     conferences.)
  242.  
  243.      /w             WIDE, optional. Permits "wide" wrapping to 80 columns of
  244.                     long lines ending with a hard CR. IP will still attempt
  245.                     to fit lines with soft CRs within 72 columns.
  246.  
  247.      /l             LEAVE, optional. Allows the option of leaving messages in
  248.                     the *.msg format on import to PCB. Use with /x option if
  249.                     you wish to leave netmail messages received.
  250.  
  251.      /o             Echo flag ON, optional. Turns the "Echo" flag on in
  252.                     imported messages and leaves it on in exported messages.
  253.                     This is mainly useful for systems gating conferences
  254.                     between networks. IP will no longer exclusively rely on
  255.                     the Echo flag to know if it has processed a message.
  256.                     The Echo flag will be ignored on export so be careful
  257.                     not to use this together with the /a switch on a conference
  258.                     -- you could scan out a bunch of dupes...
  259.  
  260.       /pvt          Allow Private mail in an echo. If used, private mail will
  261.                     be exported with the private status flag set. However,
  262.                     how they're handled after IP has exported them depends
  263.                     on how the echomail processor handles private status.
  264.  
  265.             Note that private status should never be allowed in national/
  266.             international echomail conferences, and that you should advise
  267.             your users of this fact.
  268.  
  269.       /q            QUIET MODE (optional). Supress screen output
  270.  
  271.       /u            UNCHANGED FORMATTING (optional). Tells IP to keep all 
  272.                     formatting unchanged, if possible, and to insert hard 
  273.                     CRs after every line on export. Useful for ANSI 
  274.                     conferences and Usenet newsgroups etc.
  275.  
  276.       /x            NETMAIL Conference option (optional). Private messages are
  277.                     allowed as default. See below for how to use the netmail
  278.                     feature.
  279.  
  280.       /pr           Use ASCII 13 for the End Of Line character, to
  281.                     accomodate Asiatic language character sets.
  282.  
  283.  
  284.                           HOW TO USE NETMAIL
  285.                           ==================
  286.  
  287.     You tell IP that a message area is a netmail conference by using
  288.     the /x switch.
  289.  
  290.     Only messages that are addressed to the installed network
  291.     address and have NOT been given Received status will be
  292.     imported. To specify users whose mail should be imported, put
  293.     a file called IPUSER.LST in the netmail directory. The users
  294.     should be listed each on a separate line in the file. Imported
  295.     messages will get a From: (address) on the first line, to make
  296.     it easier to reply.
  297.  
  298.     To export a message, it should have the  destination address on
  299.     the first line, pos 1, as follows:
  300.  
  301.     @>[zone:]net/node[.point][@domain]
  302.  
  303.     For example:
  304.     @>1:369/35@fidonet
  305.  
  306.     An incorrectly addressed message will still get exported, but
  307.     will be addressed to your own address and the grunged address
  308.     line will be retained in the message. This will allow you to
  309.     correct whatever mistake the user made.
  310.  
  311.  
  312.                                 ORIGIN LINES
  313.                                 ============
  314.  
  315.     You can have IP add an origin line. The origin line should be
  316.     stored in each PCBoard message directory in a plain ASCII file called
  317.     ORIGLINE.IP, e.g.:
  318.  
  319.             I'm proud of my Origin! (1:369/35)
  320.  
  321.     Tearline and " * Origin: " will be added to this text by IP.
  322.     IP will only add the origin line if it finds this file in the
  323.     PCBoard message base directory. and if there isn't already a
  324.     recognizable origin line in the message.
  325.  
  326.  
  327.                               EXPORTING MESSAGES
  328.                               ==================
  329.  
  330.     In order to export messages from PCBoard message bases, IP requires
  331.     that the ECHO flag be set. You MUST make sure that you have "Echo Mail 
  332.     in Conferences" set to yes in your PCBSETUP for each conference that
  333.     needs to be exported.
  334.  
  335.     A sample batchfile has been included (IP.BAT) showing some of the ways
  336.     in which options may be used, as well as how to set up errorhandling.
  337.  
  338.  
  339.                               INTERRUPTING IP
  340.                               ===============
  341.  
  342.     IP can be interrupted at any time by pressing Ctrl-C or Ctrl-Break.
  343.     This should be considered an "emergency brake", though. We would
  344.     recommend that you use it during the export phase, if possible,
  345.     rather than during import.
  346.  
  347.     IP will properly close all open files, but if interrupted during import,
  348.     IP won't delete imported *.msg files or update the PCBoard index, so
  349.     it will be necessary to run a pack program to take care of dupes and
  350.     update the indexes the next time you import messages.
  351.  
  352.  
  353.                                 ERRORLEVELS
  354.                                 ===========
  355.  
  356.           0    Success (no errors)
  357.           1    No messages to import
  358.           2    Fatal error (terminate)
  359.           3    Insufficient space on disk (terminate)
  360.           4    Invalid parameters
  361.           5    PCBoard message base locked (terminate)
  362.           6    Insufficient space in PCB index (increase block size)
  363.           7    Not properly installed (no network address). Run IP /inst.
  364.          10    User break (Ctrl-C or Ctrl-Break)
  365.  
  366.     These errorlevels may be picked up and used in a batch file to take
  367.     appropriate action. See sample batch file enclosed.
  368.  
  369.  
  370.  
  371.                                 Definitions
  372.                                 -----------
  373.  
  374.     Directory:     A DOS directory name, e.g. C:\PCB
  375.  
  376.     Pathname:      A complete filename including the path,
  377.                     e.g. E:\FD\PCBNET\PCBNET
  378.  
  379.  
  380.                                   WIPE
  381.                                   ====
  382.  
  383.     Wipe is similar to PCMag's sweep.com in that it will delete all files
  384.     on a drive.  The syntax is:
  385.  
  386.     WIPE [drive:][path][.ext] [/b] [/e]
  387.  
  388.     All parameters are optional.  The default is for Wipe to delete all
  389.     files with the extension BAK on the current drive and require
  390.     confirmation of each deletion.
  391.  
  392.     If you specify a path, WIPE will only search downwards in the directory
  393.     tree from the specified path.
  394.  
  395.     The /b parameter (for batch mode) is necessary to operate WIPE from a
  396.     batch file.  The extensions .exe, .com, .sys, .bat, .ovr, and .ovl are
  397.     illegal for batch mode operation.
  398.  
  399.     The /e parameter is only necessary if you are in the habit of using
  400.     directory names with extensions, e.g. D:\PCB.NET\MSG.FIL\  (Very few
  401.     people do...)
  402.  
  403.  
  404.                                   CREDITS
  405.                                   =======
  406.  
  407.     All InterZone products are trademarks or registered trademarks of
  408.     InterZone Software, Inc.
  409.  
  410.     InterMail 2.21, Copyright 1988-93 InterZone Software, Inc. & Scandinavian
  411.     PC Systems AB, is a mailer program developed and marketed by InterZone
  412.     Software, Inc. in cooperation with Scandinavian PC Systems.
  413.  
  414.     PCBoard is a registered trademark of Clark Development Company and CDC
  415.     does not support this program.
  416.  
  417.     Other brand and product names are trademarks or registered trademarks
  418.     of their respective holders.
  419.  
  420.  
  421.     Support:  BBS: The InterZone Cafe (305)436-1085 <HST>
  422.               FidoNet Node 1:369/35 <HST>
  423.               EchoNet Node 50:5305/35 <HST>
  424.  
  425.               BBS: SunShine PCBoard (305)432-2223 <HST>
  426.               FidoNet Node 1:369/21 <HST>
  427.               EchoNet Node 50:5305/21 <HST>
  428.  
  429.